Audit
This functionality allows for retrieving the list of fields being audited as well as audit information about specific fields on a loan.
API | Description |
---|---|
GET api/audit/{authenticationToken} |
This method retrieves the complete list of fields being audited by Epic. |
POST api/audit/{authenticationToken}/{loanKey} |
This method returns the audit information about a specific field on a loan. |
Authentication
This functionality provides a third party with an authentication token that will be used for any other Epic requests.
API | Description |
---|---|
POST api/authentication/{authenticationKey} |
This method is used to obtain an authorization token from Epic based on an authorization key and credentials provided to the third party. This token will be valid for a configurable period of time then will expire. This token will be used for all other Epic requests. |
PUT api/authentication/test/{authenticationKey} |
This is a test method is used to set test credentials for the Epic API documentation test pages. |
GET api/authentication/test |
This method provides the current test credentials Epic API documentation test pages. |
Channel
This functionality provides the ability to retrieve information about the different business channels defined in Epic
API | Description |
---|---|
GET api/channel/{authenticationToken}/{loanKey} |
This method will return the business channel data associated with a specific loan. |
POST api/channel/{authenticationToken} |
This method will return a list of business channels defined in Epic based on the criteria passed in. |
Data
This functionality provides for the ability to both read and write data to and from loans.
API | Description |
---|---|
GET api/data/{authenticationToken}/{loanNumber} |
This method returns a loan key based on the loan number of the desired loan. |
POST api/data/{authenticationToken}/{loanKey} |
This method is used to retrieve data from a loan. |
POST api/data/global/{authenticationToken} |
This method is used to retrieve global data from Epic (ie: from the Container). |
PUT api/data/{authenticationToken}/{loanKey} |
This method is used to write data to a loan. |
DU
This functionality provides the ability to export a Desktop Underwriter 3.2 file from an existing loan, create a new loan by importing a DU 3.2 or 3.4 file, and to update an existing loan by importing a DU 3.2 or 3.4 file.
API | Description |
---|---|
GET api/du/{authenticationToken}/{loanKey} |
This method will return a DU 3.2 export file for the specified loan. |
GET api/mismo/{authenticationToken}/{loanKey} |
This method will return a MISMO 3.4 export file for the specified loan. |
POST api/du/{authenticationToken} |
This method will create a new loan based on the DU 3.2 or 3.4 import file being passed in. |
PUT api/du/{authenticationToken}/{loanKey} |
This method will update the specified loan with the data in the DU 3.2 or 3.4 file. |
Function
This functionality provides for the ability to execute both container and loan functions.
API | Description |
---|---|
POST api/function/{authenticationToken}/{functionName} |
This method is used to execute a container function. |
POST api/function/{authenticationToken}/{loanKey}/{functionName} |
This method is used to execute a loan function. |
Imaging
This functionality provides the ability to retrieve information about imaged documents and to send documents to Epic for imaging.
API | Description |
---|---|
GET api/documents/{authenticationToken} |
This method retrieves the list of all documents that are available for imaging. |
GET api/documents/{authenticationToken}/{id} |
This methods the document information for a specific document (task). |
GET api/imaging/{authenticationToken}/{loanKey} |
This method returns all of the documents imaged on a loan. |
GET api/imaging/{authenticationToken}/{loanKey}/{id} |
This method returns all of the images for a specific document (task) on a loan. |
GET api/imaging/last/{authenticationToken}/{loanKey}/{id} |
This method returns the last image for a specific document (task) on a loan. |
POST api/imaging/{authenticationToken}/{loanKey} |
This method is used to save one or more document images to a loan. |
Report
This functionality is used to pull reporting information about loans in Epic. This may be done by either a loan creation date range or by an explicit list of loan keys.
API | Description |
---|---|
POST api/report/range/{authenticationToken} |
This method is used to return a loan report based on a date range for when loans were created. |
POST api/report/loans/{authenticationToken} |
This method is used to return a loan report based on a list of loan keys. |
Status
This functionality provides the ability to collect general status information from Epic setups, status history data for a specific loan, current status information about a loan, and also provides the ability to change a loan's status to a permitted status (based on channel and security permissions).
API | Description |
---|---|
GET api/status/{authenticationToken} |
This method returns all loan statuses defined in Epic. |
GET api/status/{authenticationToken}/{loanKey} |
This method returns the list of status option to which the loan may be changed based on channel and permissions. |
GET api/status/history/{authenticationToken}/{loanKey} |
This method returns the status history for a loan. |
GET api/status/current/{authenticationToken}/{loanKey} |
This method returns the status information for the current status on a loan. |
PUT api/status/{authenticationToken}/{loanKey} |
This method is used to change the loan status on a loan. |
User
This functionality is used to pull reporting information about users in Epic.
API | Description |
---|---|
POST api/users/email/{authenticationToken} |
This method is used to return a list of users that have a specified email address. While only one user should be returned, it is technically possible that multiple users set up in Epic have the same email address. |
POST api/users/{authenticationToken} |
This method is used to return a list of Epic users based on their active state and user type. |
Version
This functionality provides version information about individual components of the Epic API interface. These methods do not require any authentication.
API | Description |
---|---|
GET api/version/{name} |
This method is used to retrieve the version of a specific component of the Epic API. |
GET api/Version |
This method provides the three main components and their versions for the Epic API interface. |